
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>create-http-lb</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>create-http-lb</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="create-http-health-checker.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-http-lb-config.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="create-http-lb-1"></a><a id="GSRFM00027"></a><a id="create-http-lb"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_create_http_lb">create-http-lb</h2>
<div class="sectionbody">
<div class="paragraph">
<p>creates a load balancer</p>
</div>
<div id="sthref243" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] create-http-lb [--help]
--devicehost device_host_or_IP_address --deviceport device_port
[--sslproxyhost proxy_host]
[--sslproxyport proxy_port] [--target target] [--lbpolicy lbpolicy] [--lbpolicymodule lb_policy_module] [--healthcheckerurl url]
[--healthcheckerinterval 10] [--healthcheckertimeout 10]
[--lbenableallinstances=true] [--lbenableallapplications=true] [--lbweight instance=weight[:instance=weight]*] [--responsetimeout 60] [--httpsrouting=false] [--reloadinterval60][--monitor=false][--routecookie=true]
[--property (name=value)[:name=value]*
] load_balancer_name</code></pre>
</div>
</div>
<div id="sthref244" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>Use the <code>create-http-lb</code> subcommand to create a load balancer, including
the load balancer configuration, target reference, and health checker. A
load balancer is a representation of the actual load balancer device,
defined by its device host and port information. Once you&#8217;ve created the
load balancer, you can automatically apply changes made to the load
balancer configuration without running <code>export-http-lb-config</code> and
manually copying the generated load balancer configuration file to the
web server instance.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>This subcommand is only applicable to Oracle Payara Server. This
subcommand is not applicable to Payara Server Open Source Edition.</p>
</div>
</td>
</tr>
</table>
</div>
<div id="sthref245" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--devicehost</code></dt>
<dd>
<p>The device host or the IP address of the load balancing device. This
host or IP is where the physical load balancer will reside.</p>
</dd>
<dt class="hdlist1"><code>--deviceport</code></dt>
<dd>
<p>The port used to communicate with the load balancing device. It must
be SSL enabled.</p>
</dd>
<dt class="hdlist1"><code>--sslproxyhost</code></dt>
<dd>
<p>The proxy host used for outbound HTTP.</p>
</dd>
<dt class="hdlist1"><code>--sslproxyport</code></dt>
<dd>
<p>The proxy port used for outbound HTTP.</p>
</dd>
<dt class="hdlist1"><code>--target</code></dt>
<dd>
<p>Specifies the target to which the load balancer applies.<br>
Valid values are:<br></p>
<div class="ulist">
<ul>
<li>
<p>cluster_name- Specifies that requests for this cluster will be
handled by the load balancer.</p>
</li>
<li>
<p>stand-alone_instance_name- Specifies that requests for this
stand-alone instance will be handled by the load balancer.</p>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1"><code>--lbpolicy</code></dt>
<dd>
<p>The policy the load balancer follows to distribute load to the server
instances in a cluster. Valid values are <code>round-robin</code>,
<code>weighted-round-robin</code>, and <code>user-defined</code>. If you choose
<code>user-defined</code>, specify a load balancer policy module with the
<code>lbpolicymodule</code> option. If you choose <code>weighted-round-robin</code>, assign
weights to the server instances using the <code>configure-lb-weight</code>
subcommand. The default is <code>round-robin</code>.</p>
</dd>
<dt class="hdlist1"><code>--lbpolicymodule</code></dt>
<dd>
<p>If your target is a cluster and the load balancer policy is
<code>user-defined</code>, use this option to specify the full path and name of
the shared library of your load balancing policy module. The shared
library needs to be in a location accessible by the web server.</p>
</dd>
<dt class="hdlist1"><code>--healthcheckerurl</code></dt>
<dd>
<p>The URL to ping to determine whether the instance is healthy.</p>
</dd>
<dt class="hdlist1"><code>--healthcheckerinterval</code></dt>
<dd>
<p>The interval in seconds the health checker waits between checks of an
unhealthy instance to see whether it has become healthy. The default
value is 10 seconds. A value of 0 disables the health checker.</p>
</dd>
<dt class="hdlist1"><code>--healthcheckertimeout</code></dt>
<dd>
<p>The interval in seconds the health checker waits to receive a response
from an instance. If the health checker has not received a response in
this interval, the instance is considered unhealthy. The default value
is 10 seconds.</p>
</dd>
<dt class="hdlist1"><code>--lbenableallinstances</code></dt>
<dd>
<p>Enables all instances in the target cluster for load balancing. If the
target is a server instance, enables that instance for load balancing.</p>
</dd>
<dt class="hdlist1"><code>--lbenableallapplications</code></dt>
<dd>
<p>Enables all applications deployed to the target cluster or instance
for load balancing.</p>
</dd>
<dt class="hdlist1"><code>--lbweight</code></dt>
<dd>
<p>The name of the instance and the weight you are assigning it. The
weight must be an integer. The pairs of instances and weights are
separated by colons. For example <code>instance1=1:instance2=4</code> means that
for every five requests, one goes to instance1 and four go to
instance2. A weight of 1 is the default.</p>
</dd>
<dt class="hdlist1"><code>--responsetimeout</code></dt>
<dd>
<p>The time in seconds within which a server instance must return a
response. If no response is received within the time period, the
server is considered unhealthy. If set to a positive number, and the
request is idempotent, the request is retried. If the request is not
idempotent, an error page is returned. If set to 0 no timeout is used.
The default is 60.</p>
</dd>
<dt class="hdlist1"><code>--httpsrouting</code></dt>
<dd>
<p>If set to <code>true</code>, HTTPS requests to the load balancer result in HTTPS
requests to the server instance. If set to <code>false</code>, HTTPS requests to
the load balancer result in HTTP requests to the server instance. The
default is <code>false</code>.</p>
</dd>
<dt class="hdlist1"><code>--reloadinterval</code></dt>
<dd>
<p>The time, in seconds, that the load balancer takes to check for an
updated configuration. When detected, the configuration file is
reloaded. The default value is 60 seconds. A value of 0 disables
reloading.</p>
</dd>
<dt class="hdlist1"><code>--monitor</code></dt>
<dd>
<p>If set to <code>true</code>, monitoring of the load balancer is switched on. The
default value is <code>false</code>.</p>
</dd>
<dt class="hdlist1"><code>--routecookie</code></dt>
<dd>
<p>This option is deprecated. The value is always true.</p>
</dd>
<dt class="hdlist1"><code>--property</code></dt>
<dd>
<p>Optional attribute name/value pairs for configuring the load balancer.</p>
</dd>
</dl>
</div>
<div id="sthref246" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">lb_name</dt>
<dd>
<p>The name of the new load balancer. This name must not conflict with
any other load balancers in the domain.</p>
</dd>
</dl>
</div>
<div id="sthref247" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM478"></a><a id="sthref248"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Creating a Load Balancer</p>
</div>
<div class="paragraph">
<p>This example creates a load balancer named <code>mylb</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; create-http-lb
--devicehost host1 --deviceport 5555 mylb

Command create-http-lb executed successfully.</code></pre>
</div>
</div>
<div id="sthref249" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>subcommand executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the subcommand</p>
</dd>
</dl>
</div>
<div id="sthref250" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="delete-http-lb.html#delete-http-lb-1"><code>delete-http-lb</code>(1)</a>,
<a href="list-http-lbs.html#list-http-lbs-1"><code>list-http-lbs</code>(1)</a>,
<a href="create-http-lb-config.html#create-http-lb-config-1"><code>create-http-lb-config</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="create-http-health-checker.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-http-lb-config.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
